Отменить заказ

Запрос позволяет отменить созданный заказ.

Синтаксис запроса

POST https://business.taxi.yandex.ru/api/1.0/client/{идентификатор клиента}/order/{идентификатор заказа}/cancel

🔴 Рекомендуем использовать API 2.0. Поддержка API 1.0 в будущем будет прекращена.

Заголовки запроса:

Authorization

OAuth-токен. Процесс получения токена описан в разделе Начало работы.

Данные о заказе передаются в теле запроса в формате JSON:

Поле Описание Формат
state Статус отмены. Для получения статуса отмены, используйте запрос Детальная информация о заказе с параметром show_cancel_text=true. Строка

Описание полей ответа

В ответе могут содержаться следующие поля:

Поле Описание Формат
_id Идентификационный номер отменяемого заказа. Строка

Пример запроса

POST https://business.taxi.yandex.ru/api/1.0/client/a2...d09/order/9b...7ee8/cancel
...
Authorization: <OAuth-токен>        

{
    "state": "free"
}

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
    "_id": "3caa3587675b49deb62e3286b753b05e"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

  • 200 — запрос выполнен успешно.
  • 400 — был передан неверно сформированный запрос.
  • 401 — был передан неверный OAuth-токен.
  • 404 — заказ не был найден.
  • 409 — заказ не может быть отменен.
Предыдущая
Обработка заказа
Следующая
Детальная информация о заказе